.TH E1432_SET_DECIMATION_FILTER 3 E1432
.SH NAME
e1432_set_decimation_filter \- Set most decimation filter parameters
.IX e1432_set_decimation_filter(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_decimation_filter(E1432ID hw, SHORTSIZ16 ID,
                                       SHORTSIZ16 output,
                                       SHORTSIZ16 state,
                                       SHORTSIZ16 decBw)
.cE
.SH DESCRIPTION

This function is provided only for backward compatibility with the
E1431 Host Interface Library.  All new code should use
\fIe1432_set_span\fR, \fIe1432_set_decimation_output\fR, and
\fIe1432_set_anti_alias_digital\fR instead.

\fIe1432_set_decimation_filter\fR sets all of the parameters
associated with the decimation filter section of an E1432 or group of
E1432s, except the filter settling time.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained by a
call to \fIe1432_create_channel_group\fR, or the ID of a single channel.

\fIoutput\fR selects the type of output from the decimation filter.
Using \fBE1432_ONEPASS\fR for this parameter selects the output of the
last filter in the chain.  This is the normal operating mode of the
filter.  Using \fBE1432_MULTIPASS\fR causes an output consisting of
the time multiplexed outputs of all cascaded filters equal to or
narrower than the programmed bandwidth.  This parameter may also be
set with \fIe1432_set_decimation_output\fR.

\fIstate\fR determines the state of the digital anti-alias filter.
\fBE1432_ANTI_ALIAS_DIGITAL_ON\fR enables it, and
\fBE1432_ANTI_ALIAS_DIGITAL_OFF\fR bypasses it.  This parameter may
also be set with \fIe1432_set_anti_alias_digital\fR.

\fIdecBw\fR selects the bandwidth of the filter and the amount of
decimation applied to the signal.  The possible values for this
parameter range from 0 to 9.  This parameter may also be set with
\fIe1432_set_decimation_bandwidth\fR, but a better way to set the
amount of decimation is to call \fIe1432_set_span\fR.
.SH "RESET VALUE"
After a reset, \fIstate\fR is set to \fBE1432_ANTI_ALIAS_DIGITAL_ON\fR,
\fIoutput\fR is set to \fBE1432_ONEPASS\fR,
and \fIdecBw\fR is set to \fB0\fR (i.e. maximum span).
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_set_anti_alias_digital, e1432_set_decimation_bandwidth,
e1432_set_decimation_output, e1432_set_span
.ad
